Index
Interactive Cross Reference for Windows NT

Version 1.1a

Quick Start

Introduction

Features

Hardware and System Requirements

How do I....?

open a .xfw file?

learn fancy MFC programming in one month?

cross reference other programming languages?

disable the IXFW_NT from adding items to the Program Manager?

cut & paste between IXFW_NT and other editor?

References

Identifier List Box

Reference List Box

History List Box

File Viewer Window

Whats Next?

Help me decide what I should develop next by filling out the survey.

Shareware Registration

Shareware upgrade policy

Copyright and distribution right


Quick Start

Welcome to Interactive Cross Reference for Windows.   We strongly recommend that you experiment with the program for a few minutes before browse the rest of this document.   Try the following commands:

Experiment with the different menus and windows.

Use "IXRef->Add Files" to add any  C/C++ source files or text files to the database.

Position the cursor over any text on the screen and double-click the left mouse button then press the right mouse button and observe what happen.

Try the "Tab", "Enter", "Up", "Down", "Page Up", "Page Down", "Alt-F1" and "Shift-Enter" keys in all of the windows and observe what happens.


Introduction

Interactive Cross Reference for Windows (IXFW_NT.EXE) is a programming tool that helps the programmer quickly understand C/C++ source code, other text files and programming languages.


Features

IXFW_NT lets you cross reference C or C++ source code and your text files.  It has:

Simple point-and-click action using the mouse or keyboard for selection.

Fast database load time.

Easy-to-use interface with standard menu and status line layout. If you have used Borland IDE, Microsoft PWB, Windows, OS/2, or Apple Macintosh before, you can master this software interface in seconds.

Support for multiple windows to multiple project database.

Interactive Windows Help provides further information for the keyword under the cursor/mouse pointer from your Windows help files (e.g. Win SDK, MFC, OWL help files).


Requirements
Hardware and System Requirements

IBM-compatible machine with an 80386 processor or higher.

Windows NT Version 3.1 or higher.  I use NT 3.5 with no problem.


Meat
The Meat - What is this & How do I do this?

Different ways to open a .xfw file

How do I learn fancy MFC programming in one month?

Can I cross reference other programming languages?

Interaction between the IXFW_NT and the Program Manager.


Open_xfw
Different ways to open a .xfw file?

1)  Double click the .xfw file from the Windows File Manager.

2) Double click the .xfw files icon in the Windows Program Manager.  The IXFW_NT.exe will automatically add a icon to the IXFW_NT group of the program manager when your save a .xfw.

3) Use the File menu and Open the file.

4) Drag the .xfw file to the IXFW_NT.exe icon or windows.   - Yes it supports drag and drop operation.


Learn_MFC
How do I learn how to program fancy features in MFC in one month or less?

Its very easy to build trivial program with VC++ / MFC, but the learn curve go up exponentially as your app need the fancier features that are not explicitly document in the MFC manual.   That why I design this tool in the first place.

1) Register my software.

2) Build the .xfw database for MFC source, include directory.

Hint: Select the include path checkbox in the Add File dialog to build database from source files in multiple directory.

3) Build another .xfw database for MFC Sample code.

4) Build all the sample code applications.

5) Run these sample program and see what features they use.

6) When you see the feature you like, open the .xfw database and browse the code.

7)  Do use the History Listbox to track the list of reference.  It will be much easier for you to go back and forth in the various point of the source code instantly and you will understand the source code much faster.


OtherTextFile
Can I cross reference other programming language?

Yes!!!  This program will try to parse any text file you throw at it.

For C/C++ program, it will remove the comments from your source code.

For Windows program, you can parse C/C++ and resource files all together.  You will know where the ID_!@#$%^&* is defined and exactly who use it INSTANTLY.

For Visual Basic programmers, you can save the source code as the ASCII file.   This program will parse your code.    You can learn a lot about VB programming by parse the text file of sample code provided by Microsoft.

If you need a fancier features for you favor programming language, please let me know.


ProgMan
Interaction between the IXFW_NT and the Program Manager.

Interactive Cross Reference for Windows will add the database name/icon to the IXFWIN group in the Windows program manager.   I designed this features so that the programmers can centrally locate ALL the cross reference database.

It is very useful if you like to build a lot of cross reference databases and like to have IXFW_NT to keep track you these databases for you automatically.

The feature can be disable with IXREF->Disabe Progman Update menu item.


CutAndPaste
Copy and paste between IXFW_NT and other editor.

Step 1:	Double click the filename in the Reference list box.

This would open the file with Notepad.

Step 2:	Copy and paste the source code to your programming environment.


Bone
The Bone Reference

Identifier List Box:

The Identifier List Box displays all of the identifiers in the source files.  This list appears on the lower left side of the window.

Keyboard and mouse actions	Functions
Up, Down, Page up, Page Down	Scroll the Identifiers list.
Enter, Right Mouse Button	Enter current selection in the History List Box.
Tab	Move cursor to the Reference List Box.
a-z, A-Z	Interactively search for case-sensitive identifier string in the database.
Delete	Clear the current interactive search buffer.

Reference List Box:

The Reference List Box displays all of the references to the current identifier in the Identifier List Box. This list appears in the lower middle section of the window.

Keyboard and mouse actions	Functions
Up, Down, Page up, Page Down	Scroll the Reference list.
Enter, Right Mouse Button	Enter current selection in the History List Box.
Tab	Move cursor to the History List Box..

Trace History List Box:

The History List Box maintains a list of previously referenced items. The initially empty list is updated automatically when you press the Enter key while in the various window panes. This list appears in the lower right side of the window.

Keyboard and mouse actions	Functions
Up, Down, Page up, Page Down	Scroll the Reference list. As this list is scrolled, the other lists are updated automatically.
Tab	Move cursor to the File Viewer Window.
File Viewer Window:

The File Viewer pane lets you view the source file that references the current token. This window pane is located in the upper portion of the window.

Keyboard and mouse actions	Functions
Up, Down, Page up, Page Down	Scroll the current display file.
ENTER	Query the database for the currently referenced token.
SHIFT-ENTER	Query the database for the current referenced token. If a match is found, this identifier is entered into the History List box.
Tab	Move cursor to the File Viewer Window.
Double Click Left Mouse	Display reference for the token to which the cursor is pointing.
Right Mouse	Same as "Left Mouse"; also add current reference to the History List.


What_Next
Whats Next?

If you have a strong interested In what I should develop next, please fill out the survey.

With your registration support, I plan to:

Add support to cataloging and selecting multiple token list.

Let users document the code as they trace through it.


Survey

Name:	 ____________________ 	Title:	________________

Address:	 ____________________

City:	 ____________________ 	State:  __	Zip: _____-____

Country:	_____________________

Phone:	 ____________________	Fax:	 ____________________

Email:	_____________________

I use the following operation system:

_ DOS	_ Windows	_ Win NT	_ OS/2	_ Mac	_ Unix

The OS I use most often is: 	__________________________

I use the following development tools:

1. ________________________________________________________

2. ________________________________________________________

3. ________________________________________________________

4. ________________________________________________________

5. ________________________________________________________

I like to see you develop for:

_ DOS	_ Windows	_ OS/2	_ Mac	_ Unix

_ PowerPC	_ HPUX	_Sun Unix, 	_ AIX

I will pay  $ __________ for IXF being ported to ___________.   Our company will buy ______ copy of licenses.

I read the following programming magazines regularly:

1. ________________________________________________________

2. ________________________________________________________

3. ________________________________________________________

4. ________________________________________________________

5. ________________________________________________________

I go to the following tradeshow / conference:

1. ________________________________________________________

2. ________________________________________________________

3. ________________________________________________________

4. ________________________________________________________

5. ________________________________________________________

I like to see the following features in your next Windows release:

1. ________________________________________________________

2. ________________________________________________________

3. ________________________________________________________

4. ________________________________________________________

5. ________________________________________________________

Please fill out this form and fax it to me:  Your survey result will help me determine where I should put the resource in the next port.


Registration
Shareware Registration

Press here to see what I will develop with your registration support.

The registration fee for this shareware is $120.00.

    To register, you can

Use your MC, Visa, AMEX, or Discover and call

1-800-2424-Psl and ask for product number #11712.

-------------------------------------------------------------------------

"CREDIT CARD ORDERS ONLY -

"You can order with MC, Visa, Amex, or Discover from Public (software) Library by calling 800-2424-PsL or 713-524-6394 or by FAX to 713-524-6398 or by CIS Email to 71355,470. You can also mail credit card orders to PsL at P.O.Box 35705, Houston, TX 77235-5705. "The product number for the Interactive Cross Reference for Windows NT is #11712."

"THE ABOVE NUMBERS ARE FOR ORDERS ONLY."

"Any questions about the status of the shipment of the order, refunds, registration options, product details, technical support, volume discounts, dealer pricing, site licenses, etc., must be directed to

 Orange Software

 39629 Whitecap Way

 Fremont, Ca 94538

 U.S.A.

or Email me (Tony Lee)  at  CompuServe:  	72064,1235

or contact me with Voice/Fax:	510-657-5668

"To insure that you get the latest version, PsL will notify us the day of

your order and we will ship the product directly to you.


Upgrade_Policy
Upgrade Policy

When you register your software, you can get 6 months of shareware upgrade for free.  I will do this procedure via E-mail only.  When I upload an new version of shareware, I will send you an new software license for free and you have to download the shareware from CIS or Internet yourself.


CopyRight
Copyright and Distribution Right

You are free and encourage to distribute this software IXFW_NT.EXE to anyone.

Commercial software tool developers company also free and encourage to distribute this software with your sample source code cdrom disk.

I would love to see this program get put into Microsoft development CD and a whole set of databases are built for them and the users can pull the database/technote off the CD anytime they want it.

So can Borland, Symantec and Watcom.


Address
My Address

Tony Lee

Orange Software

39629 Whitecap Way

Fremont, Ca 94538

U.S.A.

Email: CompuServe:  	72064,1235

Voice/Fax:	510-657-5668